/**
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

package pittypat;

/**
 * 表示参数在一个功能中所起的作用。
 */
public enum ParameterRole {
	/**
	 * 普通参数。
	 */
	NORMAL(0),

	/**
	 * 分页查询的页码。
	 */
	PAGE_INDEX(1),

	/**
	 * 分页查询的页面尺寸。
	 */
	PAGE_SIZE(2),

	/**
	 * 返回符合条件的总行数。
	 */
	TOTAL_ROWS(3),

	/**
	 * 查询时用于排序的列的名称。
	 */
	ORDER_NAME(4),

	/**
	 * 查询时用于排序的方向。
	 */
	ORDER_DIRECTION(5),

	/**
	 * 当前用户的 Id。参数值会由系统自动设置，不需要客户端传递值。
	 */
	USER_ID(6),

	/**
	 * 当前用户的用户令牌。因为安全原因，不会向目标参数传递用户令牌值。
	 */
	USER_TOKEN(7),

	/**
	 * 返回原始的文件路径。主要用于在 API 层删除对应的物理文件。
	 */
	OLD_URL(8);

	private int code;

	private ParameterRole(int code) {
		this.code = code;
	}

	/**
	 * 获取作用代码。
	 * 
	 * @return 作用代码。
	 */
	public int getCode() {
		return this.code;
	}
}
